home *** CD-ROM | disk | FTP | other *** search
/ Shareware Super Platinum 8 / Shareware Super Platinum 8.iso / mac / PROGTOOL / MNUWRITE.ZIP;1 / MNUWRITE.DOC next >
Encoding:
Text File  |  1992-08-20  |  10.4 KB  |  231 lines
  1.  
  2.                        The Renegade Menu Writer v1.0
  3.                        ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  4.              Program and Documentation Written by Pat McCormick
  5.  
  6.                        For Renegade version 8-10 beta
  7.  
  8.                -= Documentation and Licensing Information =-
  9.  
  10. Boring Stuff First:
  11.  
  12.                           ---====DISCLAIMER====---
  13.  
  14.       This program may screw up your menus. It is a slight chance, but I
  15. don't have 3000 beta test sites for this to make sure, so be careful. It does
  16. NOT write to the other Renegade data files, just reads from them for MCI
  17. data. You ought to back up your menus anyway, since you might some day
  18. destroy 20 items in the Main Menu file and watch Renegade's built-in editor
  19. save the shrunken version for you.
  20.  
  21.                              --===LICENSING===--
  22.  
  23.       This is SHAREWARE. We all know what that is, so I'll get down to the
  24. details. You can use this program for up to 30 days - past that, if you would
  25. like to continue using it, you are REQUIRED to register it for the minimal
  26. sum of $10.00 US. If you register, you get full support for the product from
  27. me, free updates (see Comments & Suggestions), and unlimited license to the
  28. program.
  29.  
  30.  
  31. Enough with this, here's the important part - the manual:
  32.  
  33.  
  34. Introduction:
  35.  
  36.       One of the strengths of the Renegade BBS system is in its flexible menu
  37. system. Using the menus, you can customize your bulletin board quickly and
  38. easily, and without the complexities of modifying source code. You can use
  39. the MCI codes and various color commands in full force through the menu
  40. system, adding much to the way your BBS looks and functions.
  41.       Unfortunately, one of the weakness of the menu system lies in the
  42. built-in menu editor. It does not include editing capabilities of any sort,
  43. and is overall very clunky. And so, this program was born.
  44.       
  45.  
  46. Features:
  47.  
  48.    The Renegade Menu Writer includes:
  49.  
  50.       *  Full support of all color commands, including pipes, hearts, and
  51.          carats.
  52.  
  53.       *  Full support of all MCI commands, including the new a-f codes of
  54.          8-10 beta.
  55.  
  56.       *  Fully functional editing commands, including Word Left/Right, Home,
  57.          and End.
  58.  
  59.       *  An environment with split-screen, so you can work on menu items
  60.          while having the necessary general menu data right above, instead of
  61.          having to flip back and forth.
  62.  
  63.       *  A summary screen, which shows you all of the menu items at a glance.
  64.  
  65.       *  Realtime translation of color and MCI codes, allowing you to see
  66.          what your work will look like as you type it.
  67.  
  68.       *  Automatic translation of heart color codes to carat color codes.
  69.  
  70.       *  Zoom feature which shows ALL of your descriptions and prompts, even
  71.          line feeds.
  72.  
  73.       *  Pop-up color and character set tables, making it easier to create
  74.          eye-catching prompts using high-order ASCII characters and pipe color
  75.          codes.
  76.  
  77.  
  78. How To Use Menu Writer:
  79.  
  80.       To start Menu Writer, enter the command "MNUWRITE" followed by the path
  81. to the directory with RENEGADE.DAT. Menu Writer will load and show you a
  82. listing of all of the menu files in your Renegade menu directory. You can
  83. Open a file, Delete a file, or Quit. If you Open a file which does not exist,
  84. Menu Writer will offer to create it for you.
  85.    Once you have loaded a menu, you will see a split screen and a status line
  86. area. The top screen is the Menu Summary window. Here, you can see a summary
  87. of the general menu options, including menu titles and the prompt. The status
  88. area shows the name of your file, the current column on the line you are
  89. working on, the the current item number and total items, and a bar showing
  90. the sysop's color map for carat codes 0-9.
  91.  
  92. Editing in Menu Writer:
  93.  
  94.       In the Menu Item Edit window, there are several fields which comprise
  95. the menu item. You can use standard editing keys to change the fields. The
  96. editing keys are:
  97.  
  98.             Left/Right Arrow       Moves Left/Right
  99.             End                    Moves to last character in field
  100.             Home                   Moves to first character in field
  101.             Insert                 Changes Insert mode
  102.             Delete                 Deletes character at cursor
  103.             Control-Left/Right     Moves one word Left/Right
  104.             Control-End            Moves to the rightmost boundary of field
  105.  
  106. Other keys will move you between fields and menu items:
  107.  
  108.             Tab/Enter/Down Arrow   Moves to Next Field
  109.             Shift-Tab/Up Arrow     Moves Back one Field
  110.             PgUp/PgDn              Moves Up/Down one Item
  111.             Control-PgUp           Moves to First Item
  112.             Control-PgDn           Moves to Last Item
  113.  
  114. If you are in doubt, the status line will give you an idea of what keys can
  115. be used in a field. For example, the Flags field will only accept an H, a U,
  116. or a blank space.
  117.  
  118.       To zoom in and see what the current field looks like with all codes
  119. implemented, press the Zoom key, F5. Press it again to see the Menu Summary
  120. Screen again. Note that the zoom only works with long fields, including the
  121. descriptions, the Options field, and the Titles and Prompt fields.
  122.  
  123. Menu Item Management:
  124.  
  125.       To manage your menu items, you can use the Insert, Delete, and Move
  126. options. Simply use PgUp/PgDn so that you are looking at the card you want to
  127. work with, and press Alt-I, Alt-D, or Alt-M.
  128.       Alt-I will insert a new card before the current card. If you wish to
  129. insert a card after the last card, go to the last card and press Alt-I. It
  130. will ask if you want to insert before or after the last card. 
  131.       Alt-D will delete the current card. There is NO undo function, so be
  132. careful!
  133.       Alt-M will ask where you want to move the current card. It will insert
  134. the card BEFORE the card you tell it to move to, just like the insert
  135. function.
  136.  
  137.       Another method of Item Management is through the Menu Item Summary
  138. screen. Press Alt-S to bring up the Summary Screen. You will see a condensed
  139. listing of all of the menu items. Here, you can use the Insert, Delete, and
  140. Move functions just by pressing I,D, or M. ESC will bring you back to the
  141. Item Editing Screen.
  142.  
  143. Changing the General Menu Options:
  144.  
  145.       To edit the general options, press Alt-T, the Toggle key. The bottom
  146. half of the screen will be changed to show information on the general
  147. options. You can use all of the editing keys and the zoom key just like in
  148. the item editing screen. On the bottom lines of the window are some number
  149. options and flags. The number options do not use editing keys, they just
  150. accept 0-9 input. As a matter of fact, the Right and Left Arrows will change
  151. the field you are in on the one-character options, as a convenience. The
  152. flags are turned on and off using the spacebar. The status line will remind
  153. you of the active keys, as well as giving you information about the current
  154. field.
  155.  
  156. Pop Up Windows:
  157.  
  158.       If you press F2 or F3, the top window will be replaced by tables of the
  159. color codes and high-order (above 127) ASCII codes.
  160.  
  161. Exiting and Saving your Work:
  162.  
  163.       To exit, you can use either Alt-Q or ESC. The Escape Key will abandon
  164. all of your changes and not save anything to disk. Alt-Q asks if you wish to
  165. exit, then asks if you wish to save your work.
  166.       Once you have left the menu editing screen, you can work with other
  167. menu files, or quit back to DOS.
  168.  
  169.  
  170. Quick Reference:
  171.  
  172. Here is a listing of all of the special keys used in Menu Writer:
  173.  
  174.             Alt-Q                  Exits Editing Screens
  175.             Escape                 Fast Exit
  176.             Alt-S                  Shows Summary Screen
  177.             Alt-T                  Toggles between Item Edit and General Edit
  178.             Alt-I                  Inserts one card before current card
  179.             Alt-D                  Deletes current card
  180.             Alt-M                  Moves current card to another location
  181.             F2                     Pops up the color table
  182.             F3                     Pops up the high-order character set
  183.             F5                     Opens Zoom Window for selected fields
  184.  
  185.  
  186. Technical Notes:
  187.  
  188.       The Menu Writer will read from the Renegade data files when it starts
  189. up so to give you MCI codes that are as close to what Renegade will return as
  190. possible. Sometimes, when Menu Writer is run in a shell from Renegade,
  191. Renegade will have some of the data files open for its own use, creating a
  192. sharing violation. In this case, (it has only happened with MBASES and
  193. FBASES.) Menu Writer will not report an error, just fake the necessary MCI
  194. codes. Since the MBASES and FBASES files are only needed for the first
  195. file/msg area name, you may not notice the faked codes at all. If you somehow
  196. get an error with USERS.DAT or RENEGADE.DAT which seems like a sharing error,
  197. simply exit out of RG totally and run it, or shell to DOS from a different
  198. area of RG and try to get it to work.
  199.       I have gotten the Menu Writer to run through the DOS Shell and as a
  200. local door with no problems. I highly doubt that it will work remotely, as it
  201. uses direct video calls very heavily. That's the biggest advantage of RG's
  202. own editor; it works over the phone line! If you like, one of the first
  203. things you can do with Renegade Menu Editor is to add a new item to the sysop
  204. menu which accesses MNUWRITE, which will make it much more accessible while
  205. maintaining the BBS.
  206.       For those who need it, there is a command line switch that will force
  207. Menu Writer to use BIOS calls. Just add a -b after the pathname on the command
  208. line, and it will go much much slower, but eliminate some compatibility 
  209. problems.
  210.  
  211.  
  212. Comments:
  213.  
  214.       I will update Menu Writer as new versions of RG roll out, as I am sure
  215. they will. I am entertaining the idea of including some sort of pop up help
  216. on keystrokes and their options as well as MCI code help in some future
  217. version.
  218.  
  219.       Any kinds of bug reports (no matter how small), comments, and suggest-
  220. ions for future versions would be highly appreciated. You can reach me at
  221. these electronic addresses:
  222.  
  223.          Compuserve: 76437,1215
  224.          InterNet  : 76437.1215@compuserve.com
  225.          FidoNet   : 1:266/34
  226.          ITCNet    : 85:862/400
  227.  
  228.       You can also reach me at the Alpha State BBS at (609)751-7446. Many
  229. thanks to sysop Excalibur for his help in beta-testing this program and
  230. moving it out into general distribution for me.
  231.